<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>ActiveQuery, yii\db\ActiveQuery - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w9143" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w9143-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w9143-collapse" class="collapse navbar-collapse"><ul id="w9144" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w9145" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item" href="#navigation-9112" data-toggle="collapse" data-parent="#navigation">Not namespaced classes <b class="caret"></b></a><div id="navigation-9112" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii.html">Yii</a></div>
<a class="list-group-item" href="#navigation-9113" data-toggle="collapse" data-parent="#navigation">yii <b class="caret"></b></a><div id="navigation-9113" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-baseyii.html">BaseYii</a></div>
<a class="list-group-item" href="#navigation-9114" data-toggle="collapse" data-parent="#navigation">yii\base <b class="caret"></b></a><div id="navigation-9114" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-base-action.html">Action</a>
<a class="list-group-item" href="./yii-base-actionevent.html">ActionEvent</a>
<a class="list-group-item" href="./yii-base-actionfilter.html">ActionFilter</a>
<a class="list-group-item" href="./yii-base-application.html">Application</a>
<a class="list-group-item" href="./yii-base-arrayaccesstrait.html">ArrayAccessTrait</a>
<a class="list-group-item" href="./yii-base-arrayable.html">Arrayable</a>
<a class="list-group-item" href="./yii-base-arrayabletrait.html">ArrayableTrait</a>
<a class="list-group-item" href="./yii-base-behavior.html">Behavior</a>
<a class="list-group-item" href="./yii-base-bootstrapinterface.html">BootstrapInterface</a>
<a class="list-group-item" href="./yii-base-component.html">Component</a>
<a class="list-group-item" href="./yii-base-configurable.html">Configurable</a>
<a class="list-group-item" href="./yii-base-controller.html">Controller</a>
<a class="list-group-item" href="./yii-base-dynamicmodel.html">DynamicModel</a>
<a class="list-group-item" href="./yii-base-errorexception.html">ErrorException</a>
<a class="list-group-item" href="./yii-base-errorhandler.html">ErrorHandler</a>
<a class="list-group-item" href="./yii-base-event.html">Event</a>
<a class="list-group-item" href="./yii-base-exception.html">Exception</a>
<a class="list-group-item" href="./yii-base-exitexception.html">ExitException</a>
<a class="list-group-item" href="./yii-base-inlineaction.html">InlineAction</a>
<a class="list-group-item" href="./yii-base-invalidcallexception.html">InvalidCallException</a>
<a class="list-group-item" href="./yii-base-invalidconfigexception.html">InvalidConfigException</a>
<a class="list-group-item" href="./yii-base-invalidparamexception.html">InvalidParamException</a>
<a class="list-group-item" href="./yii-base-invalidrouteexception.html">InvalidRouteException</a>
<a class="list-group-item" href="./yii-base-invalidvalueexception.html">InvalidValueException</a>
<a class="list-group-item" href="./yii-base-model.html">Model</a>
<a class="list-group-item" href="./yii-base-modelevent.html">ModelEvent</a>
<a class="list-group-item" href="./yii-base-module.html">Module</a>
<a class="list-group-item" href="./yii-base-notsupportedexception.html">NotSupportedException</a>
<a class="list-group-item" href="./yii-base-object.html">Object</a>
<a class="list-group-item" href="./yii-base-request.html">Request</a>
<a class="list-group-item" href="./yii-base-response.html">Response</a>
<a class="list-group-item" href="./yii-base-security.html">Security</a>
<a class="list-group-item" href="./yii-base-theme.html">Theme</a>
<a class="list-group-item" href="./yii-base-unknownclassexception.html">UnknownClassException</a>
<a class="list-group-item" href="./yii-base-unknownmethodexception.html">UnknownMethodException</a>
<a class="list-group-item" href="./yii-base-unknownpropertyexception.html">UnknownPropertyException</a>
<a class="list-group-item" href="./yii-base-userexception.html">UserException</a>
<a class="list-group-item" href="./yii-base-view.html">View</a>
<a class="list-group-item" href="./yii-base-viewcontextinterface.html">ViewContextInterface</a>
<a class="list-group-item" href="./yii-base-viewevent.html">ViewEvent</a>
<a class="list-group-item" href="./yii-base-viewrenderer.html">ViewRenderer</a>
<a class="list-group-item" href="./yii-base-widget.html">Widget</a></div>
<a class="list-group-item" href="#navigation-9115" data-toggle="collapse" data-parent="#navigation">yii\behaviors <b class="caret"></b></a><div id="navigation-9115" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-behaviors-attributebehavior.html">AttributeBehavior</a>
<a class="list-group-item" href="./yii-behaviors-blameablebehavior.html">BlameableBehavior</a>
<a class="list-group-item" href="./yii-behaviors-sluggablebehavior.html">SluggableBehavior</a>
<a class="list-group-item" href="./yii-behaviors-timestampbehavior.html">TimestampBehavior</a></div>
<a class="list-group-item" href="#navigation-9116" data-toggle="collapse" data-parent="#navigation">yii\caching <b class="caret"></b></a><div id="navigation-9116" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-caching-apccache.html">ApcCache</a>
<a class="list-group-item" href="./yii-caching-arraycache.html">ArrayCache</a>
<a class="list-group-item" href="./yii-caching-cache.html">Cache</a>
<a class="list-group-item" href="./yii-caching-chaineddependency.html">ChainedDependency</a>
<a class="list-group-item" href="./yii-caching-dbcache.html">DbCache</a>
<a class="list-group-item" href="./yii-caching-dbdependency.html">DbDependency</a>
<a class="list-group-item" href="./yii-caching-dependency.html">Dependency</a>
<a class="list-group-item" href="./yii-caching-dummycache.html">DummyCache</a>
<a class="list-group-item" href="./yii-caching-expressiondependency.html">ExpressionDependency</a>
<a class="list-group-item" href="./yii-caching-filecache.html">FileCache</a>
<a class="list-group-item" href="./yii-caching-filedependency.html">FileDependency</a>
<a class="list-group-item" href="./yii-caching-memcache.html">MemCache</a>
<a class="list-group-item" href="./yii-caching-memcacheserver.html">MemCacheServer</a>
<a class="list-group-item" href="./yii-caching-tagdependency.html">TagDependency</a>
<a class="list-group-item" href="./yii-caching-wincache.html">WinCache</a>
<a class="list-group-item" href="./yii-caching-xcache.html">XCache</a>
<a class="list-group-item" href="./yii-caching-zenddatacache.html">ZendDataCache</a></div>
<a class="list-group-item" href="#navigation-9117" data-toggle="collapse" data-parent="#navigation">yii\captcha <b class="caret"></b></a><div id="navigation-9117" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-captcha-captcha.html">Captcha</a>
<a class="list-group-item" href="./yii-captcha-captchaaction.html">CaptchaAction</a>
<a class="list-group-item" href="./yii-captcha-captchaasset.html">CaptchaAsset</a>
<a class="list-group-item" href="./yii-captcha-captchavalidator.html">CaptchaValidator</a></div>
<a class="list-group-item" href="#navigation-9118" data-toggle="collapse" data-parent="#navigation">yii\console <b class="caret"></b></a><div id="navigation-9118" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-console-application.html">Application</a>
<a class="list-group-item" href="./yii-console-controller.html">Controller</a>
<a class="list-group-item" href="./yii-console-errorhandler.html">ErrorHandler</a>
<a class="list-group-item" href="./yii-console-exception.html">Exception</a>
<a class="list-group-item" href="./yii-console-markdown.html">Markdown</a>
<a class="list-group-item" href="./yii-console-request.html">Request</a>
<a class="list-group-item" href="./yii-console-response.html">Response</a></div>
<a class="list-group-item" href="#navigation-9119" data-toggle="collapse" data-parent="#navigation">yii\console\controllers <b class="caret"></b></a><div id="navigation-9119" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-console-controllers-assetcontroller.html">AssetController</a>
<a class="list-group-item" href="./yii-console-controllers-basemigratecontroller.html">BaseMigrateController</a>
<a class="list-group-item" href="./yii-console-controllers-cachecontroller.html">CacheController</a>
<a class="list-group-item" href="./yii-console-controllers-fixturecontroller.html">FixtureController</a>
<a class="list-group-item" href="./yii-console-controllers-helpcontroller.html">HelpController</a>
<a class="list-group-item" href="./yii-console-controllers-messagecontroller.html">MessageController</a>
<a class="list-group-item" href="./yii-console-controllers-migratecontroller.html">MigrateController</a>
<a class="list-group-item" href="./yii-console-controllers-servecontroller.html">ServeController</a></div>
<a class="list-group-item" href="#navigation-9120" data-toggle="collapse" data-parent="#navigation">yii\data <b class="caret"></b></a><div id="navigation-9120" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-data-activedataprovider.html">ActiveDataProvider</a>
<a class="list-group-item" href="./yii-data-arraydataprovider.html">ArrayDataProvider</a>
<a class="list-group-item" href="./yii-data-basedataprovider.html">BaseDataProvider</a>
<a class="list-group-item" href="./yii-data-dataproviderinterface.html">DataProviderInterface</a>
<a class="list-group-item" href="./yii-data-pagination.html">Pagination</a>
<a class="list-group-item" href="./yii-data-sort.html">Sort</a>
<a class="list-group-item" href="./yii-data-sqldataprovider.html">SqlDataProvider</a></div>
<a class="list-group-item active" href="#navigation-9121" data-toggle="collapse" data-parent="#navigation">yii\db <b class="caret"></b></a><div id="navigation-9121" class="submenu panel-collapse collapse in"><a class="list-group-item active" href="./yii-db-activequery.html">ActiveQuery</a>
<a class="list-group-item" href="./yii-db-activequeryinterface.html">ActiveQueryInterface</a>
<a class="list-group-item" href="./yii-db-activequerytrait.html">ActiveQueryTrait</a>
<a class="list-group-item" href="./yii-db-activerecord.html">ActiveRecord</a>
<a class="list-group-item" href="./yii-db-activerecordinterface.html">ActiveRecordInterface</a>
<a class="list-group-item" href="./yii-db-activerelationtrait.html">ActiveRelationTrait</a>
<a class="list-group-item" href="./yii-db-aftersaveevent.html">AfterSaveEvent</a>
<a class="list-group-item" href="./yii-db-baseactiverecord.html">BaseActiveRecord</a>
<a class="list-group-item" href="./yii-db-batchqueryresult.html">BatchQueryResult</a>
<a class="list-group-item" href="./yii-db-columnschema.html">ColumnSchema</a>
<a class="list-group-item" href="./yii-db-columnschemabuilder.html">ColumnSchemaBuilder</a>
<a class="list-group-item" href="./yii-db-command.html">Command</a>
<a class="list-group-item" href="./yii-db-connection.html">Connection</a>
<a class="list-group-item" href="./yii-db-datareader.html">DataReader</a>
<a class="list-group-item" href="./yii-db-exception.html">Exception</a>
<a class="list-group-item" href="./yii-db-expression.html">Expression</a>
<a class="list-group-item" href="./yii-db-integrityexception.html">IntegrityException</a>
<a class="list-group-item" href="./yii-db-migration.html">Migration</a>
<a class="list-group-item" href="./yii-db-migrationinterface.html">MigrationInterface</a>
<a class="list-group-item" href="./yii-db-query.html">Query</a>
<a class="list-group-item" href="./yii-db-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-db-queryinterface.html">QueryInterface</a>
<a class="list-group-item" href="./yii-db-querytrait.html">QueryTrait</a>
<a class="list-group-item" href="./yii-db-schema.html">Schema</a>
<a class="list-group-item" href="./yii-db-schemabuildertrait.html">SchemaBuilderTrait</a>
<a class="list-group-item" href="./yii-db-staleobjectexception.html">StaleObjectException</a>
<a class="list-group-item" href="./yii-db-tableschema.html">TableSchema</a>
<a class="list-group-item" href="./yii-db-transaction.html">Transaction</a></div>
<a class="list-group-item" href="#navigation-9122" data-toggle="collapse" data-parent="#navigation">yii\db\cubrid <b class="caret"></b></a><div id="navigation-9122" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-db-cubrid-columnschemabuilder.html">ColumnSchemaBuilder</a>
<a class="list-group-item" href="./yii-db-cubrid-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-db-cubrid-schema.html">Schema</a></div>
<a class="list-group-item" href="#navigation-9123" data-toggle="collapse" data-parent="#navigation">yii\db\mssql <b class="caret"></b></a><div id="navigation-9123" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-db-mssql-pdo.html">PDO</a>
<a class="list-group-item" href="./yii-db-mssql-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-db-mssql-schema.html">Schema</a>
<a class="list-group-item" href="./yii-db-mssql-sqlsrvpdo.html">SqlsrvPDO</a>
<a class="list-group-item" href="./yii-db-mssql-tableschema.html">TableSchema</a></div>
<a class="list-group-item" href="#navigation-9124" data-toggle="collapse" data-parent="#navigation">yii\db\mysql <b class="caret"></b></a><div id="navigation-9124" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-db-mysql-columnschemabuilder.html">ColumnSchemaBuilder</a>
<a class="list-group-item" href="./yii-db-mysql-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-db-mysql-schema.html">Schema</a></div>
<a class="list-group-item" href="#navigation-9125" data-toggle="collapse" data-parent="#navigation">yii\db\oci <b class="caret"></b></a><div id="navigation-9125" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-db-oci-columnschemabuilder.html">ColumnSchemaBuilder</a>
<a class="list-group-item" href="./yii-db-oci-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-db-oci-schema.html">Schema</a></div>
<a class="list-group-item" href="#navigation-9126" data-toggle="collapse" data-parent="#navigation">yii\db\pgsql <b class="caret"></b></a><div id="navigation-9126" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-db-pgsql-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-db-pgsql-schema.html">Schema</a></div>
<a class="list-group-item" href="#navigation-9127" data-toggle="collapse" data-parent="#navigation">yii\db\sqlite <b class="caret"></b></a><div id="navigation-9127" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-db-sqlite-columnschemabuilder.html">ColumnSchemaBuilder</a>
<a class="list-group-item" href="./yii-db-sqlite-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-db-sqlite-schema.html">Schema</a></div>
<a class="list-group-item" href="#navigation-9128" data-toggle="collapse" data-parent="#navigation">yii\di <b class="caret"></b></a><div id="navigation-9128" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-di-container.html">Container</a>
<a class="list-group-item" href="./yii-di-instance.html">Instance</a>
<a class="list-group-item" href="./yii-di-notinstantiableexception.html">NotInstantiableException</a>
<a class="list-group-item" href="./yii-di-servicelocator.html">ServiceLocator</a></div>
<a class="list-group-item" href="#navigation-9129" data-toggle="collapse" data-parent="#navigation">yii\filters <b class="caret"></b></a><div id="navigation-9129" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-filters-accesscontrol.html">AccessControl</a>
<a class="list-group-item" href="./yii-filters-accessrule.html">AccessRule</a>
<a class="list-group-item" href="./yii-filters-contentnegotiator.html">ContentNegotiator</a>
<a class="list-group-item" href="./yii-filters-cors.html">Cors</a>
<a class="list-group-item" href="./yii-filters-httpcache.html">HttpCache</a>
<a class="list-group-item" href="./yii-filters-pagecache.html">PageCache</a>
<a class="list-group-item" href="./yii-filters-ratelimitinterface.html">RateLimitInterface</a>
<a class="list-group-item" href="./yii-filters-ratelimiter.html">RateLimiter</a>
<a class="list-group-item" href="./yii-filters-verbfilter.html">VerbFilter</a></div>
<a class="list-group-item" href="#navigation-9130" data-toggle="collapse" data-parent="#navigation">yii\filters\auth <b class="caret"></b></a><div id="navigation-9130" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-filters-auth-authinterface.html">AuthInterface</a>
<a class="list-group-item" href="./yii-filters-auth-authmethod.html">AuthMethod</a>
<a class="list-group-item" href="./yii-filters-auth-compositeauth.html">CompositeAuth</a>
<a class="list-group-item" href="./yii-filters-auth-httpbasicauth.html">HttpBasicAuth</a>
<a class="list-group-item" href="./yii-filters-auth-httpbearerauth.html">HttpBearerAuth</a>
<a class="list-group-item" href="./yii-filters-auth-queryparamauth.html">QueryParamAuth</a></div>
<a class="list-group-item" href="#navigation-9131" data-toggle="collapse" data-parent="#navigation">yii\grid <b class="caret"></b></a><div id="navigation-9131" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-grid-actioncolumn.html">ActionColumn</a>
<a class="list-group-item" href="./yii-grid-checkboxcolumn.html">CheckboxColumn</a>
<a class="list-group-item" href="./yii-grid-column.html">Column</a>
<a class="list-group-item" href="./yii-grid-datacolumn.html">DataColumn</a>
<a class="list-group-item" href="./yii-grid-gridview.html">GridView</a>
<a class="list-group-item" href="./yii-grid-gridviewasset.html">GridViewAsset</a>
<a class="list-group-item" href="./yii-grid-serialcolumn.html">SerialColumn</a></div>
<a class="list-group-item" href="#navigation-9132" data-toggle="collapse" data-parent="#navigation">yii\helpers <b class="caret"></b></a><div id="navigation-9132" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-helpers-arrayhelper.html">ArrayHelper</a>
<a class="list-group-item" href="./yii-helpers-basearrayhelper.html">BaseArrayHelper</a>
<a class="list-group-item" href="./yii-helpers-baseconsole.html">BaseConsole</a>
<a class="list-group-item" href="./yii-helpers-basefilehelper.html">BaseFileHelper</a>
<a class="list-group-item" href="./yii-helpers-baseformatconverter.html">BaseFormatConverter</a>
<a class="list-group-item" href="./yii-helpers-basehtml.html">BaseHtml</a>
<a class="list-group-item" href="./yii-helpers-basehtmlpurifier.html">BaseHtmlPurifier</a>
<a class="list-group-item" href="./yii-helpers-baseinflector.html">BaseInflector</a>
<a class="list-group-item" href="./yii-helpers-basejson.html">BaseJson</a>
<a class="list-group-item" href="./yii-helpers-basemarkdown.html">BaseMarkdown</a>
<a class="list-group-item" href="./yii-helpers-basestringhelper.html">BaseStringHelper</a>
<a class="list-group-item" href="./yii-helpers-baseurl.html">BaseUrl</a>
<a class="list-group-item" href="./yii-helpers-basevardumper.html">BaseVarDumper</a>
<a class="list-group-item" href="./yii-helpers-console.html">Console</a>
<a class="list-group-item" href="./yii-helpers-filehelper.html">FileHelper</a>
<a class="list-group-item" href="./yii-helpers-formatconverter.html">FormatConverter</a>
<a class="list-group-item" href="./yii-helpers-html.html">Html</a>
<a class="list-group-item" href="./yii-helpers-htmlpurifier.html">HtmlPurifier</a>
<a class="list-group-item" href="./yii-helpers-inflector.html">Inflector</a>
<a class="list-group-item" href="./yii-helpers-json.html">Json</a>
<a class="list-group-item" href="./yii-helpers-markdown.html">Markdown</a>
<a class="list-group-item" href="./yii-helpers-stringhelper.html">StringHelper</a>
<a class="list-group-item" href="./yii-helpers-url.html">Url</a>
<a class="list-group-item" href="./yii-helpers-vardumper.html">VarDumper</a></div>
<a class="list-group-item" href="#navigation-9133" data-toggle="collapse" data-parent="#navigation">yii\i18n <b class="caret"></b></a><div id="navigation-9133" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-i18n-dbmessagesource.html">DbMessageSource</a>
<a class="list-group-item" href="./yii-i18n-formatter.html">Formatter</a>
<a class="list-group-item" href="./yii-i18n-gettextfile.html">GettextFile</a>
<a class="list-group-item" href="./yii-i18n-gettextmessagesource.html">GettextMessageSource</a>
<a class="list-group-item" href="./yii-i18n-gettextmofile.html">GettextMoFile</a>
<a class="list-group-item" href="./yii-i18n-gettextpofile.html">GettextPoFile</a>
<a class="list-group-item" href="./yii-i18n-i18n.html">I18N</a>
<a class="list-group-item" href="./yii-i18n-messageformatter.html">MessageFormatter</a>
<a class="list-group-item" href="./yii-i18n-messagesource.html">MessageSource</a>
<a class="list-group-item" href="./yii-i18n-missingtranslationevent.html">MissingTranslationEvent</a>
<a class="list-group-item" href="./yii-i18n-phpmessagesource.html">PhpMessageSource</a></div>
<a class="list-group-item" href="#navigation-9134" data-toggle="collapse" data-parent="#navigation">yii\log <b class="caret"></b></a><div id="navigation-9134" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-log-dbtarget.html">DbTarget</a>
<a class="list-group-item" href="./yii-log-dispatcher.html">Dispatcher</a>
<a class="list-group-item" href="./yii-log-emailtarget.html">EmailTarget</a>
<a class="list-group-item" href="./yii-log-filetarget.html">FileTarget</a>
<a class="list-group-item" href="./yii-log-logger.html">Logger</a>
<a class="list-group-item" href="./yii-log-syslogtarget.html">SyslogTarget</a>
<a class="list-group-item" href="./yii-log-target.html">Target</a></div>
<a class="list-group-item" href="#navigation-9135" data-toggle="collapse" data-parent="#navigation">yii\mail <b class="caret"></b></a><div id="navigation-9135" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-mail-basemailer.html">BaseMailer</a>
<a class="list-group-item" href="./yii-mail-basemessage.html">BaseMessage</a>
<a class="list-group-item" href="./yii-mail-mailevent.html">MailEvent</a>
<a class="list-group-item" href="./yii-mail-mailerinterface.html">MailerInterface</a>
<a class="list-group-item" href="./yii-mail-messageinterface.html">MessageInterface</a></div>
<a class="list-group-item" href="#navigation-9136" data-toggle="collapse" data-parent="#navigation">yii\mutex <b class="caret"></b></a><div id="navigation-9136" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-mutex-dbmutex.html">DbMutex</a>
<a class="list-group-item" href="./yii-mutex-filemutex.html">FileMutex</a>
<a class="list-group-item" href="./yii-mutex-mutex.html">Mutex</a>
<a class="list-group-item" href="./yii-mutex-mysqlmutex.html">MysqlMutex</a>
<a class="list-group-item" href="./yii-mutex-pgsqlmutex.html">PgsqlMutex</a></div>
<a class="list-group-item" href="#navigation-9137" data-toggle="collapse" data-parent="#navigation">yii\rbac <b class="caret"></b></a><div id="navigation-9137" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-rbac-assignment.html">Assignment</a>
<a class="list-group-item" href="./yii-rbac-basemanager.html">BaseManager</a>
<a class="list-group-item" href="./yii-rbac-checkaccessinterface.html">CheckAccessInterface</a>
<a class="list-group-item" href="./yii-rbac-dbmanager.html">DbManager</a>
<a class="list-group-item" href="./yii-rbac-item.html">Item</a>
<a class="list-group-item" href="./yii-rbac-managerinterface.html">ManagerInterface</a>
<a class="list-group-item" href="./yii-rbac-permission.html">Permission</a>
<a class="list-group-item" href="./yii-rbac-phpmanager.html">PhpManager</a>
<a class="list-group-item" href="./yii-rbac-role.html">Role</a>
<a class="list-group-item" href="./yii-rbac-rule.html">Rule</a></div>
<a class="list-group-item" href="#navigation-9138" data-toggle="collapse" data-parent="#navigation">yii\rest <b class="caret"></b></a><div id="navigation-9138" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-rest-action.html">Action</a>
<a class="list-group-item" href="./yii-rest-activecontroller.html">ActiveController</a>
<a class="list-group-item" href="./yii-rest-controller.html">Controller</a>
<a class="list-group-item" href="./yii-rest-createaction.html">CreateAction</a>
<a class="list-group-item" href="./yii-rest-deleteaction.html">DeleteAction</a>
<a class="list-group-item" href="./yii-rest-indexaction.html">IndexAction</a>
<a class="list-group-item" href="./yii-rest-optionsaction.html">OptionsAction</a>
<a class="list-group-item" href="./yii-rest-serializer.html">Serializer</a>
<a class="list-group-item" href="./yii-rest-updateaction.html">UpdateAction</a>
<a class="list-group-item" href="./yii-rest-urlrule.html">UrlRule</a>
<a class="list-group-item" href="./yii-rest-viewaction.html">ViewAction</a></div>
<a class="list-group-item" href="#navigation-9139" data-toggle="collapse" data-parent="#navigation">yii\test <b class="caret"></b></a><div id="navigation-9139" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-test-activefixture.html">ActiveFixture</a>
<a class="list-group-item" href="./yii-test-arrayfixture.html">ArrayFixture</a>
<a class="list-group-item" href="./yii-test-baseactivefixture.html">BaseActiveFixture</a>
<a class="list-group-item" href="./yii-test-dbfixture.html">DbFixture</a>
<a class="list-group-item" href="./yii-test-fixture.html">Fixture</a>
<a class="list-group-item" href="./yii-test-fixturetrait.html">FixtureTrait</a>
<a class="list-group-item" href="./yii-test-initdbfixture.html">InitDbFixture</a></div>
<a class="list-group-item" href="#navigation-9140" data-toggle="collapse" data-parent="#navigation">yii\validators <b class="caret"></b></a><div id="navigation-9140" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-validators-booleanvalidator.html">BooleanValidator</a>
<a class="list-group-item" href="./yii-validators-comparevalidator.html">CompareValidator</a>
<a class="list-group-item" href="./yii-validators-datevalidator.html">DateValidator</a>
<a class="list-group-item" href="./yii-validators-defaultvaluevalidator.html">DefaultValueValidator</a>
<a class="list-group-item" href="./yii-validators-eachvalidator.html">EachValidator</a>
<a class="list-group-item" href="./yii-validators-emailvalidator.html">EmailValidator</a>
<a class="list-group-item" href="./yii-validators-existvalidator.html">ExistValidator</a>
<a class="list-group-item" href="./yii-validators-filevalidator.html">FileValidator</a>
<a class="list-group-item" href="./yii-validators-filtervalidator.html">FilterValidator</a>
<a class="list-group-item" href="./yii-validators-imagevalidator.html">ImageValidator</a>
<a class="list-group-item" href="./yii-validators-inlinevalidator.html">InlineValidator</a>
<a class="list-group-item" href="./yii-validators-ipvalidator.html">IpValidator</a>
<a class="list-group-item" href="./yii-validators-numbervalidator.html">NumberValidator</a>
<a class="list-group-item" href="./yii-validators-punycodeasset.html">PunycodeAsset</a>
<a class="list-group-item" href="./yii-validators-rangevalidator.html">RangeValidator</a>
<a class="list-group-item" href="./yii-validators-regularexpressionvalidator.html">RegularExpressionValidator</a>
<a class="list-group-item" href="./yii-validators-requiredvalidator.html">RequiredValidator</a>
<a class="list-group-item" href="./yii-validators-safevalidator.html">SafeValidator</a>
<a class="list-group-item" href="./yii-validators-stringvalidator.html">StringValidator</a>
<a class="list-group-item" href="./yii-validators-uniquevalidator.html">UniqueValidator</a>
<a class="list-group-item" href="./yii-validators-urlvalidator.html">UrlValidator</a>
<a class="list-group-item" href="./yii-validators-validationasset.html">ValidationAsset</a>
<a class="list-group-item" href="./yii-validators-validator.html">Validator</a></div>
<a class="list-group-item" href="#navigation-9141" data-toggle="collapse" data-parent="#navigation">yii\web <b class="caret"></b></a><div id="navigation-9141" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-web-application.html">Application</a>
<a class="list-group-item" href="./yii-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yii-web-assetconverter.html">AssetConverter</a>
<a class="list-group-item" href="./yii-web-assetconverterinterface.html">AssetConverterInterface</a>
<a class="list-group-item" href="./yii-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yii-web-badrequesthttpexception.html">BadRequestHttpException</a>
<a class="list-group-item" href="./yii-web-cachesession.html">CacheSession</a>
<a class="list-group-item" href="./yii-web-compositeurlrule.html">CompositeUrlRule</a>
<a class="list-group-item" href="./yii-web-conflicthttpexception.html">ConflictHttpException</a>
<a class="list-group-item" href="./yii-web-controller.html">Controller</a>
<a class="list-group-item" href="./yii-web-cookie.html">Cookie</a>
<a class="list-group-item" href="./yii-web-cookiecollection.html">CookieCollection</a>
<a class="list-group-item" href="./yii-web-dbsession.html">DbSession</a>
<a class="list-group-item" href="./yii-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yii-web-errorhandler.html">ErrorHandler</a>
<a class="list-group-item" href="./yii-web-forbiddenhttpexception.html">ForbiddenHttpException</a>
<a class="list-group-item" href="./yii-web-gonehttpexception.html">GoneHttpException</a>
<a class="list-group-item" href="./yii-web-groupurlrule.html">GroupUrlRule</a>
<a class="list-group-item" href="./yii-web-headercollection.html">HeaderCollection</a>
<a class="list-group-item" href="./yii-web-htmlresponseformatter.html">HtmlResponseFormatter</a>
<a class="list-group-item" href="./yii-web-httpexception.html">HttpException</a>
<a class="list-group-item" href="./yii-web-identityinterface.html">IdentityInterface</a>
<a class="list-group-item" href="./yii-web-jqueryasset.html">JqueryAsset</a>
<a class="list-group-item" href="./yii-web-jsexpression.html">JsExpression</a>
<a class="list-group-item" href="./yii-web-jsonparser.html">JsonParser</a>
<a class="list-group-item" href="./yii-web-jsonresponseformatter.html">JsonResponseFormatter</a>
<a class="list-group-item" href="./yii-web-link.html">Link</a>
<a class="list-group-item" href="./yii-web-linkable.html">Linkable</a>
<a class="list-group-item" href="./yii-web-methodnotallowedhttpexception.html">MethodNotAllowedHttpException</a>
<a class="list-group-item" href="./yii-web-multifieldsession.html">MultiFieldSession</a>
<a class="list-group-item" href="./yii-web-notacceptablehttpexception.html">NotAcceptableHttpException</a>
<a class="list-group-item" href="./yii-web-notfoundhttpexception.html">NotFoundHttpException</a>
<a class="list-group-item" href="./yii-web-request.html">Request</a>
<a class="list-group-item" href="./yii-web-requestparserinterface.html">RequestParserInterface</a>
<a class="list-group-item" href="./yii-web-response.html">Response</a>
<a class="list-group-item" href="./yii-web-responseformatterinterface.html">ResponseFormatterInterface</a>
<a class="list-group-item" href="./yii-web-servererrorhttpexception.html">ServerErrorHttpException</a>
<a class="list-group-item" href="./yii-web-session.html">Session</a>
<a class="list-group-item" href="./yii-web-sessioniterator.html">SessionIterator</a>
<a class="list-group-item" href="./yii-web-toomanyrequestshttpexception.html">TooManyRequestsHttpException</a>
<a class="list-group-item" href="./yii-web-unauthorizedhttpexception.html">UnauthorizedHttpException</a>
<a class="list-group-item" href="./yii-web-unprocessableentityhttpexception.html">UnprocessableEntityHttpException</a>
<a class="list-group-item" href="./yii-web-unsupportedmediatypehttpexception.html">UnsupportedMediaTypeHttpException</a>
<a class="list-group-item" href="./yii-web-uploadedfile.html">UploadedFile</a>
<a class="list-group-item" href="./yii-web-urlmanager.html">UrlManager</a>
<a class="list-group-item" href="./yii-web-urlrule.html">UrlRule</a>
<a class="list-group-item" href="./yii-web-urlruleinterface.html">UrlRuleInterface</a>
<a class="list-group-item" href="./yii-web-user.html">User</a>
<a class="list-group-item" href="./yii-web-userevent.html">UserEvent</a>
<a class="list-group-item" href="./yii-web-view.html">View</a>
<a class="list-group-item" href="./yii-web-viewaction.html">ViewAction</a>
<a class="list-group-item" href="./yii-web-xmlresponseformatter.html">XmlResponseFormatter</a>
<a class="list-group-item" href="./yii-web-yiiasset.html">YiiAsset</a></div>
<a class="list-group-item" href="#navigation-9142" data-toggle="collapse" data-parent="#navigation">yii\widgets <b class="caret"></b></a><div id="navigation-9142" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-widgets-activefield.html">ActiveField</a>
<a class="list-group-item" href="./yii-widgets-activeform.html">ActiveForm</a>
<a class="list-group-item" href="./yii-widgets-activeformasset.html">ActiveFormAsset</a>
<a class="list-group-item" href="./yii-widgets-baselistview.html">BaseListView</a>
<a class="list-group-item" href="./yii-widgets-block.html">Block</a>
<a class="list-group-item" href="./yii-widgets-breadcrumbs.html">Breadcrumbs</a>
<a class="list-group-item" href="./yii-widgets-contentdecorator.html">ContentDecorator</a>
<a class="list-group-item" href="./yii-widgets-detailview.html">DetailView</a>
<a class="list-group-item" href="./yii-widgets-fragmentcache.html">FragmentCache</a>
<a class="list-group-item" href="./yii-widgets-inputwidget.html">InputWidget</a>
<a class="list-group-item" href="./yii-widgets-linkpager.html">LinkPager</a>
<a class="list-group-item" href="./yii-widgets-linksorter.html">LinkSorter</a>
<a class="list-group-item" href="./yii-widgets-listview.html">ListView</a>
<a class="list-group-item" href="./yii-widgets-maskedinput.html">MaskedInput</a>
<a class="list-group-item" href="./yii-widgets-maskedinputasset.html">MaskedInputAsset</a>
<a class="list-group-item" href="./yii-widgets-menu.html">Menu</a>
<a class="list-group-item" href="./yii-widgets-pjax.html">Pjax</a>
<a class="list-group-item" href="./yii-widgets-pjaxasset.html">PjaxAsset</a>
<a class="list-group-item" href="./yii-widgets-spaceless.html">Spaceless</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\db\ActiveQuery</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
                | <a href="#events">Events</a>
        </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a> &raquo;
<a href="yii-db-query.html">yii\db\Query</a> &raquo;
<a href="yii-base-component.html">yii\base\Component</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="yii-base-configurable.html">yii\base\Configurable</a>, <a href="yii-db-activequeryinterface.html">yii\db\ActiveQueryInterface</a>, <a href="yii-db-queryinterface.html">yii\db\QueryInterface</a></td></tr>
                    <tr><th>Uses Traits</th><td><a href="yii-db-activequerytrait.html">yii\db\ActiveQueryTrait</a>, <a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a>, <a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td></tr>
                            <tr><th>Available since version</th><td>2.0</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php">https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>ActiveQuery represents a DB query associated with an Active Record class.</strong></p>
    <div class="toc"><ol><li><a href="#normal-query">Normal Query</a></li>
<li><a href="#relational-query">Relational query</a></li></ol></div>
<p>An ActiveQuery can be a normal query or be used in a relational context.</p>
<p>ActiveQuery instances are usually created by <a href="yii-db-activerecord.html#find()-detail">yii\db\ActiveRecord::find()</a> and <a href="yii-db-activerecord.html#findBySql()-detail">yii\db\ActiveRecord::findBySql()</a>.
Relational queries are created by <a href="yii-db-baseactiverecord.html#hasOne()-detail">yii\db\ActiveRecord::hasOne()</a> and <a href="yii-db-baseactiverecord.html#hasMany()-detail">yii\db\ActiveRecord::hasMany()</a>.</p>
<h2>Normal Query <span id="normal-query"></span><a href="#normal-query" class="hashlink">&para;</a></h2><p>ActiveQuery mainly provides the following methods to retrieve the query results:</p>
<ul>
<li><a href="yii-db-activequery.html#one()-detail">one()</a>: returns a single record populated with the first row of data.</li>
<li><a href="yii-db-activequery.html#all()-detail">all()</a>: returns all records based on the query results.</li>
<li><a href="yii-db-query.html#count()-detail">count()</a>: returns the number of records.</li>
<li><a href="yii-db-query.html#sum()-detail">sum()</a>: returns the sum over the specified column.</li>
<li><a href="yii-db-query.html#average()-detail">average()</a>: returns the average over the specified column.</li>
<li><a href="yii-db-query.html#min()-detail">min()</a>: returns the min over the specified column.</li>
<li><a href="yii-db-query.html#max()-detail">max()</a>: returns the max over the specified column.</li>
<li><a href="yii-db-query.html#scalar()-detail">scalar()</a>: returns the value of the first column in the first row of the query result.</li>
<li><a href="yii-db-query.html#column()-detail">column()</a>: returns the value of the first column in the query result.</li>
<li><a href="yii-db-query.html#exists()-detail">exists()</a>: returns a value indicating whether the query result has data or not.</li>
</ul>
<p>Because ActiveQuery extends from <a href="yii-db-query.html">yii\db\Query</a>, one can use query methods, such as <a href="yii-db-querytrait.html#where()-detail">where()</a>,
<a href="yii-db-querytrait.html#orderBy()-detail">orderBy()</a> to customize the query options.</p>
<p>ActiveQuery also provides the following additional query options:</p>
<ul>
<li><a href="yii-db-activequerytrait.html#with()-detail">with()</a>: list of relations that this query should be performed with.</li>
<li><a href="yii-db-activequery.html#joinWith()-detail">joinWith()</a>: reuse a relation query definition to add a join to a query.</li>
<li><a href="yii-db-querytrait.html#indexBy()-detail">indexBy()</a>: the name of the column by which the query result should be indexed.</li>
<li><a href="yii-db-activequerytrait.html#asArray()-detail">asArray()</a>: whether to return each record as an array.</li>
</ul>
<p>These options can be configured using methods of the same name. For example:</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$customers</span> = Customer::find()-&gt;with(<span class="hljs-string">'orders'</span>)-&gt;asArray()-&gt;all();
</code></pre>
<h2>Relational query <span id="relational-query"></span><a href="#relational-query" class="hashlink">&para;</a></h2><p>In relational context ActiveQuery represents a relation between two Active Record classes.</p>
<p>Relational ActiveQuery instances are usually created by calling <a href="yii-db-baseactiverecord.html#hasOne()-detail">yii\db\ActiveRecord::hasOne()</a> and
<a href="yii-db-baseactiverecord.html#hasMany()-detail">yii\db\ActiveRecord::hasMany()</a>. An Active Record class declares a relation by defining
a getter method which calls one of the above methods and returns the created ActiveQuery object.</p>
<p>A relation is specified by <a href="yii-db-activerelationtrait.html#$link-detail">$link</a> which represents the association between columns
of different tables; and the multiplicity of the relation is indicated by <a href="yii-db-activerelationtrait.html#$multiple-detail">$multiple</a>.</p>
<p>If a relation involves a junction table, it may be specified by <a href="yii-db-activerelationtrait.html#via()-detail">via()</a> or <a href="yii-db-activequery.html#viaTable()-detail">viaTable()</a> method.
These methods may only be called in a relational context. Same is true for <a href="yii-db-activerelationtrait.html#inverseOf()-detail">inverseOf()</a>, which
marks a relation as inverse of another relation and <a href="yii-db-activequery.html#onCondition()-detail">onCondition()</a> which adds a condition that
is to be added to relational query join condition.</p>

    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="$asArray">
        <td><a href="yii-db-activequerytrait.html#$asArray-detail">$asArray</a></td>
        <td><a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>Whether to return each record as an array.</td>
        <td><a href="yii-db-activequerytrait.html">yii\db\ActiveQueryTrait</a></td>
    </tr>
            <tr class="inherited" id="$behaviors">
        <td><a href="yii-base-component.html#$behaviors-detail">$behaviors</a></td>
        <td><a href="yii-base-behavior.html">yii\base\Behavior</a>[]</td>
        <td>List of behaviors attached to this component</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="$distinct">
        <td><a href="yii-db-query.html#$distinct-detail">$distinct</a></td>
        <td><a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>Whether to select distinct rows of data only.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="$from">
        <td><a href="yii-db-query.html#$from-detail">$from</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The table(s) to be selected from.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="$groupBy">
        <td><a href="yii-db-query.html#$groupBy-detail">$groupBy</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>How to group the query results.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="$having">
        <td><a href="yii-db-query.html#$having-detail">$having</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
        <td>The condition to be applied in the GROUP BY clause.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="$indexBy">
        <td><a href="yii-db-querytrait.html#$indexBy-detail">$indexBy</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.callable">callable</a></td>
        <td>The name of the column by which the query results should be indexed by.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="$inverseOf">
        <td><a href="yii-db-activerelationtrait.html#$inverseOf-detail">$inverseOf</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The name of the relation that is the inverse of this relation.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr class="inherited" id="$join">
        <td><a href="yii-db-query.html#$join-detail">$join</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>How to join with other tables.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="$joinWith">
        <td><a href="yii-db-activequery.html#$joinWith-detail">$joinWith</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>A list of relations that this query should be joined with</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="$limit">
        <td><a href="yii-db-querytrait.html#$limit-detail">$limit</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>Maximum number of records to be returned.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="$link">
        <td><a href="yii-db-activerelationtrait.html#$link-detail">$link</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The columns of the primary and foreign tables that establish a relation.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr class="inherited" id="$modelClass">
        <td><a href="yii-db-activequerytrait.html#$modelClass-detail">$modelClass</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The name of the ActiveRecord class.</td>
        <td><a href="yii-db-activequerytrait.html">yii\db\ActiveQueryTrait</a></td>
    </tr>
            <tr class="inherited" id="$multiple">
        <td><a href="yii-db-activerelationtrait.html#$multiple-detail">$multiple</a></td>
        <td><a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>Whether this query represents a relation to more than one record.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr class="inherited" id="$offset">
        <td><a href="yii-db-querytrait.html#$offset-detail">$offset</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>Zero-based offset from where the records are to be returned.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr id="$on">
        <td><a href="yii-db-activequery.html#$on-detail">$on</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
        <td>The join condition to be used when this query is used in a relational context.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="$orderBy">
        <td><a href="yii-db-querytrait.html#$orderBy-detail">$orderBy</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>How to sort the query results.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="$params">
        <td><a href="yii-db-query.html#$params-detail">$params</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>List of query parameter values indexed by parameter placeholders.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="$primaryModel">
        <td><a href="yii-db-activerelationtrait.html#$primaryModel-detail">$primaryModel</a></td>
        <td><a href="yii-db-activerecord.html">yii\db\ActiveRecord</a></td>
        <td>The primary model of a relational query.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr class="inherited" id="$select">
        <td><a href="yii-db-query.html#$select-detail">$select</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The columns being selected.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="$selectOption">
        <td><a href="yii-db-query.html#$selectOption-detail">$selectOption</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Additional option that should be appended to the 'SELECT' keyword.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="$sql">
        <td><a href="yii-db-activequery.html#$sql-detail">$sql</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The SQL statement to be executed for retrieving AR records.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="$union">
        <td><a href="yii-db-query.html#$union-detail">$union</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>This is used to construct the UNION clause(s) in a SQL statement.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="$via">
        <td><a href="yii-db-activerelationtrait.html#$via-detail">$via</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.object">object</a></td>
        <td>The query associated with the junction table.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr class="inherited" id="$where">
        <td><a href="yii-db-querytrait.html#$where-detail">$where</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
        <td>Query condition.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="$with">
        <td><a href="yii-db-activequerytrait.html#$with-detail">$with</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>A list of relations that this query should be performed with</td>
        <td><a href="yii-db-activequerytrait.html">yii\db\ActiveQueryTrait</a></td>
    </tr>
    </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-component.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__clone()">
        <td><a href="yii-db-activerelationtrait.html#__clone()-detail">__clone()</a></td>
        <td>Clones internal objects.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr id="__construct()">
        <td><a href="yii-db-activequery.html#__construct()-detail">__construct()</a></td>
        <td>Constructor.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-component.html#__get()-detail">__get()</a></td>
        <td>Returns the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-component.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-component.html#__set()-detail">__set()</a></td>
        <td>Sets the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-component.html#__unset()-detail">__unset()</a></td>
        <td>Sets a component property to be null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="addGroupBy()">
        <td><a href="yii-db-query.html#addGroupBy()-detail">addGroupBy()</a></td>
        <td>Adds additional group-by columns to the existing ones.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="addOrderBy()">
        <td><a href="yii-db-querytrait.html#addOrderBy()-detail">addOrderBy()</a></td>
        <td>Adds additional ORDER BY columns to the query.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="addParams()">
        <td><a href="yii-db-query.html#addParams()-detail">addParams()</a></td>
        <td>Adds additional parameters to be bound to the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="addSelect()">
        <td><a href="yii-db-query.html#addSelect()-detail">addSelect()</a></td>
        <td>Add more columns to the SELECT part of the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="alias()">
        <td><a href="yii-db-activequery.html#alias()-detail">alias()</a></td>
        <td>Define an alias for the table defined in <a href="yii-db-activequerytrait.html#$modelClass-detail">$modelClass</a>.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr id="all()">
        <td><a href="yii-db-activequery.html#all()-detail">all()</a></td>
        <td>Executes query and returns all results as an array.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="andFilterCompare()">
        <td><a href="yii-db-query.html#andFilterCompare()-detail">andFilterCompare()</a></td>
        <td>Adds a filtering condition for a specific column and allow the user to choose a filter operator.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="andFilterWhere()">
        <td><a href="yii-db-querytrait.html#andFilterWhere()-detail">andFilterWhere()</a></td>
        <td>Adds an additional WHERE condition to the existing one but ignores <a href="yii-db-querytrait.html#isEmpty()-detail">empty operands</a>.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="andHaving()">
        <td><a href="yii-db-query.html#andHaving()-detail">andHaving()</a></td>
        <td>Adds an additional HAVING condition to the existing one.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="andOnCondition()">
        <td><a href="yii-db-activequery.html#andOnCondition()-detail">andOnCondition()</a></td>
        <td>Adds an additional ON condition to the existing one.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="andWhere()">
        <td><a href="yii-db-querytrait.html#andWhere()-detail">andWhere()</a></td>
        <td>Adds an additional WHERE condition to the existing one.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="asArray()">
        <td><a href="yii-db-activequerytrait.html#asArray()-detail">asArray()</a></td>
        <td>Sets the <a href="yii-db-activequerytrait.html#asArray()-detail">asArray()</a> property.</td>
        <td><a href="yii-db-activequerytrait.html">yii\db\ActiveQueryTrait</a></td>
    </tr>
            <tr class="inherited" id="attachBehavior()">
        <td><a href="yii-base-component.html#attachBehavior()-detail">attachBehavior()</a></td>
        <td>Attaches a behavior to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehaviors()">
        <td><a href="yii-base-component.html#attachBehaviors()-detail">attachBehaviors()</a></td>
        <td>Attaches a list of behaviors to the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="average()">
        <td><a href="yii-db-query.html#average()-detail">average()</a></td>
        <td>Returns the average of the specified column values.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="batch()">
        <td><a href="yii-db-query.html#batch()-detail">batch()</a></td>
        <td>Starts a batch query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="behaviors()">
        <td><a href="yii-base-component.html#behaviors()-detail">behaviors()</a></td>
        <td>Returns a list of behaviors that this component should behave as.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-component.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-component.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="column()">
        <td><a href="yii-db-query.html#column()-detail">column()</a></td>
        <td>Executes the query and returns the first column of the result.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="count()">
        <td><a href="yii-db-query.html#count()-detail">count()</a></td>
        <td>Returns the number of records.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="create()">
        <td><a href="yii-db-query.html#create()-detail">create()</a></td>
        <td>Creates a new Query object and copies its property values from an existing one.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="createCommand()">
        <td><a href="yii-db-activequery.html#createCommand()-detail">createCommand()</a></td>
        <td>Creates a DB command that can be used to execute this query.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="detachBehavior()">
        <td><a href="yii-base-component.html#detachBehavior()-detail">detachBehavior()</a></td>
        <td>Detaches a behavior from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="detachBehaviors()">
        <td><a href="yii-base-component.html#detachBehaviors()-detail">detachBehaviors()</a></td>
        <td>Detaches all behaviors from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="distinct()">
        <td><a href="yii-db-query.html#distinct()-detail">distinct()</a></td>
        <td>Sets the value indicating whether to SELECT DISTINCT or not.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="each()">
        <td><a href="yii-db-query.html#each()-detail">each()</a></td>
        <td>Starts a batch query and retrieves data row by row.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="ensureBehaviors()">
        <td><a href="yii-base-component.html#ensureBehaviors()-detail">ensureBehaviors()</a></td>
        <td>Makes sure that the behaviors declared in <a href="yii-base-component.html#behaviors()-detail">behaviors()</a> are attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="exists()">
        <td><a href="yii-db-query.html#exists()-detail">exists()</a></td>
        <td>Returns a value indicating whether the query result contains any row of data.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
                <tr class="inherited" id="filterWhere()">
        <td><a href="yii-db-querytrait.html#filterWhere()-detail">filterWhere()</a></td>
        <td>Sets the WHERE part of the query but ignores <a href="yii-db-querytrait.html#isEmpty()-detail">empty operands</a>.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="findFor()">
        <td><a href="yii-db-activerelationtrait.html#findFor()-detail">findFor()</a></td>
        <td>Finds the related records for the specified primary record.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr class="inherited" id="findWith()">
        <td><a href="yii-db-activequerytrait.html#findWith()-detail">findWith()</a></td>
        <td>Finds records corresponding to one or multiple relations and populates them into the primary models.</td>
        <td><a href="yii-db-activequerytrait.html">yii\db\ActiveQueryTrait</a></td>
    </tr>
            <tr class="inherited" id="from()">
        <td><a href="yii-db-query.html#from()-detail">from()</a></td>
        <td>Sets the FROM part of the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="getBehavior()">
        <td><a href="yii-base-component.html#getBehavior()-detail">getBehavior()</a></td>
        <td>Returns the named behavior object.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehaviors()">
        <td><a href="yii-base-component.html#getBehaviors()-detail">getBehaviors()</a></td>
        <td>Returns all behaviors attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="groupBy()">
        <td><a href="yii-db-query.html#groupBy()-detail">groupBy()</a></td>
        <td>Sets the GROUP BY part of the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="hasEventHandlers()">
        <td><a href="yii-base-component.html#hasEventHandlers()-detail">hasEventHandlers()</a></td>
        <td>Returns a value indicating whether there is any handler attached to the named event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-component.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-component.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined for this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="having()">
        <td><a href="yii-db-query.html#having()-detail">having()</a></td>
        <td>Sets the HAVING part of the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="indexBy()">
        <td><a href="yii-db-querytrait.html#indexBy()-detail">indexBy()</a></td>
        <td>Sets the <a href="yii-db-querytrait.html#indexBy()-detail">indexBy()</a> property.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr id="init()">
        <td><a href="yii-db-activequery.html#init()-detail">init()</a></td>
        <td>Initializes the object.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="innerJoin()">
        <td><a href="yii-db-query.html#innerJoin()-detail">innerJoin()</a></td>
        <td>Appends an INNER JOIN part to the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="innerJoinWith()">
        <td><a href="yii-db-activequery.html#innerJoinWith()-detail">innerJoinWith()</a></td>
        <td>Inner joins with the specified relations.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="inverseOf()">
        <td><a href="yii-db-activerelationtrait.html#inverseOf()-detail">inverseOf()</a></td>
        <td>Sets the name of the relation that is the inverse of this relation.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
                <tr class="inherited" id="join()">
        <td><a href="yii-db-query.html#join()-detail">join()</a></td>
        <td>Appends a JOIN part to the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="joinWith()">
        <td><a href="yii-db-activequery.html#joinWith()-detail">joinWith()</a></td>
        <td>Joins with the specified relations.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="leftJoin()">
        <td><a href="yii-db-query.html#leftJoin()-detail">leftJoin()</a></td>
        <td>Appends a LEFT OUTER JOIN part to the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="limit()">
        <td><a href="yii-db-querytrait.html#limit()-detail">limit()</a></td>
        <td>Sets the LIMIT part of the query.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="max()">
        <td><a href="yii-db-query.html#max()-detail">max()</a></td>
        <td>Returns the maximum of the specified column values.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="min()">
        <td><a href="yii-db-query.html#min()-detail">min()</a></td>
        <td>Returns the minimum of the specified column values.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
                <tr class="inherited" id="off()">
        <td><a href="yii-base-component.html#off()-detail">off()</a></td>
        <td>Detaches an existing event handler from this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="offset()">
        <td><a href="yii-db-querytrait.html#offset()-detail">offset()</a></td>
        <td>Sets the OFFSET part of the query.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="on()">
        <td><a href="yii-base-component.html#on()-detail">on()</a></td>
        <td>Attaches an event handler to an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="onCondition()">
        <td><a href="yii-db-activequery.html#onCondition()-detail">onCondition()</a></td>
        <td>Sets the ON condition for a relational query.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr id="one()">
        <td><a href="yii-db-activequery.html#one()-detail">one()</a></td>
        <td>Executes query and returns a single row of result.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="orFilterWhere()">
        <td><a href="yii-db-querytrait.html#orFilterWhere()-detail">orFilterWhere()</a></td>
        <td>Adds an additional WHERE condition to the existing one but ignores <a href="yii-db-querytrait.html#isEmpty()-detail">empty operands</a>.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="orHaving()">
        <td><a href="yii-db-query.html#orHaving()-detail">orHaving()</a></td>
        <td>Adds an additional HAVING condition to the existing one.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="orOnCondition()">
        <td><a href="yii-db-activequery.html#orOnCondition()-detail">orOnCondition()</a></td>
        <td>Adds an additional ON condition to the existing one.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="orWhere()">
        <td><a href="yii-db-querytrait.html#orWhere()-detail">orWhere()</a></td>
        <td>Adds an additional WHERE condition to the existing one.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="orderBy()">
        <td><a href="yii-db-querytrait.html#orderBy()-detail">orderBy()</a></td>
        <td>Sets the ORDER BY part of the query.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="params()">
        <td><a href="yii-db-query.html#params()-detail">params()</a></td>
        <td>Sets the parameters to be bound to the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr id="populate()">
        <td><a href="yii-db-activequery.html#populate()-detail">populate()</a></td>
        <td>Converts the raw query results into the format as specified by this query.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="populateRelation()">
        <td><a href="yii-db-activerelationtrait.html#populateRelation()-detail">populateRelation()</a></td>
        <td>Finds the related records and populates them into the primary models.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr id="prepare()">
        <td><a href="yii-db-activequery.html#prepare()-detail">prepare()</a></td>
        <td>Prepares for building SQL.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
                <tr class="inherited" id="rightJoin()">
        <td><a href="yii-db-query.html#rightJoin()-detail">rightJoin()</a></td>
        <td>Appends a RIGHT OUTER JOIN part to the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="scalar()">
        <td><a href="yii-db-query.html#scalar()-detail">scalar()</a></td>
        <td>Returns the query result as a scalar value.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="select()">
        <td><a href="yii-db-query.html#select()-detail">select()</a></td>
        <td>Sets the SELECT part of the query.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="sum()">
        <td><a href="yii-db-query.html#sum()-detail">sum()</a></td>
        <td>Returns the sum of the specified column values.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="trigger()">
        <td><a href="yii-base-component.html#trigger()-detail">trigger()</a></td>
        <td>Triggers an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="union()">
        <td><a href="yii-db-query.html#union()-detail">union()</a></td>
        <td>Appends a SQL statement using UNION operator.</td>
        <td><a href="yii-db-query.html">yii\db\Query</a></td>
    </tr>
            <tr class="inherited" id="via()">
        <td><a href="yii-db-activerelationtrait.html#via()-detail">via()</a></td>
        <td>Specifies the relation associated with the junction table.</td>
        <td><a href="yii-db-activerelationtrait.html">yii\db\ActiveRelationTrait</a></td>
    </tr>
            <tr id="viaTable()">
        <td><a href="yii-db-activequery.html#viaTable()-detail">viaTable()</a></td>
        <td>Specifies the junction table for a relational query.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
            <tr class="inherited" id="where()">
        <td><a href="yii-db-querytrait.html#where()-detail">where()</a></td>
        <td>Sets the WHERE part of the query.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
            <tr class="inherited" id="with()">
        <td><a href="yii-db-activequerytrait.html#with()-detail">with()</a></td>
        <td>Specifies the relations with which this query should be performed.</td>
        <td><a href="yii-db-activequerytrait.html">yii\db\ActiveQueryTrait</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                                                                                                                            <tr class="inherited" id="filterCondition()">
        <td><a href="yii-db-querytrait.html#filterCondition()-detail">filterCondition()</a></td>
        <td>Removes <a href="yii-db-querytrait.html#isEmpty()-detail">empty operands</a> from the given query condition.</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
                                                                            <tr class="inherited" id="isEmpty()">
        <td><a href="yii-db-querytrait.html#isEmpty()-detail">isEmpty()</a></td>
        <td>Returns a value indicating whether the give value is "empty".</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
                                    <tr class="inherited" id="normalizeOrderBy()">
        <td><a href="yii-db-querytrait.html#normalizeOrderBy()-detail">normalizeOrderBy()</a></td>
        <td>Normalizes format of ORDER BY data</td>
        <td><a href="yii-db-querytrait.html">yii\db\QueryTrait</a></td>
    </tr>
                                                                    <tr id="queryScalar()">
        <td><a href="yii-db-activequery.html#queryScalar()-detail">queryScalar()</a></td>
        <td>Queries a scalar value by setting <a href="yii-db-query.html#select()-detail">select()</a> first.</td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
                                            </table>
</div>

<a id="events"></a>
<div class="summary doc-event">
    <h2>Events</h2>

    <p><a href="#" class="toggle">Hide inherited events</a></p>

    <table class="summary-table table table-striped table-bordered table-hover">
    <colgroup>
        <col class="col-event" />
        <col class="col-type" />
        <col class="col-description" />
        <col class="col-defined" />
    </colgroup>
    <tr>
        <th>Event</th><th>Type</th><th>Description</th><th>Defined By</th>
    </tr>
        <tr id="EVENT_INIT">
        <td><a href="yii-db-activequery.html#EVENT_INIT-detail">EVENT_INIT</a></td>
        <td>\yii\db\Event</td>
        <td>
            An event that is triggered when the query is initialized via <a href="yii-db-activequery.html#init()-detail">init()</a>.                    </td>
        <td><a href="yii-db-activequery.html">yii\db\ActiveQuery</a></td>
    </tr>
        </table>
</div>

<a id="constants"></a>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$joinWith-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#$joinWith-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L99" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L99" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $joinWith        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>A list of relations that this query should be joined with</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <a href="yii-db-activequery.html#$joinWith-detail">$joinWith</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$on-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#$on-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L95" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L95" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $on        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The join condition to be used when this query is used in a relational context.
The condition will be used in the ON part when <a href="yii-db-activequery.html#joinWith()-detail">yii\db\ActiveQuery::joinWith()</a> is called.
Otherwise, the condition will be used in the WHERE part of a query.
Please refer to <a href="yii-db-query.html#where()-detail">yii\db\Query::where()</a> on how to specify this parameter.</p>

        <p>See also <a href="yii-db-activequery.html#onCondition()-detail">onCondition()</a>.</p>    </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></span> <a href="yii-db-activequery.html#$on-detail">$on</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$sql-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#$sql-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L87" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L87" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $sql        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The SQL statement to be executed for retrieving AR records.
This is set by <a href="yii-db-activerecord.html#findBySql()-detail">yii\db\ActiveRecord::findBySql()</a>.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-db-activequery.html#$sql-detail">$sql</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="__construct()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#__construct()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L107" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L107" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        __construct()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Constructor.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-db-activequery.html#__construct()-detail">__construct</a></strong> ( <span style="color: #0000BB">$modelClass</span>, <span style="color: #0000BB">$config&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$modelClass</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The model class associated with this query</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$config</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Configurations to be applied to the newly created query object</p>
</td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="alias()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#alias()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L778" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L778" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        alias()
        <span class="detail-header-tag small">
            public                                    method
                            (available since version 2.0.7)
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Define an alias for the table defined in <a href="yii-db-activequerytrait.html#$modelClass-detail">$modelClass</a>.</strong></p>

        <p>This method will adjust <a href="yii-db-query.html#from()-detail">from()</a> so that an already defined alias will be overwritten.
If none was defined, <a href="yii-db-query.html#from()-detail">from()</a> will be populated with the given alias.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#alias()-detail">alias</a></strong> ( <span style="color: #0000BB">$alias</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$alias</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table alias.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>The query object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="all()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#all()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L131" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L131" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        all()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Executes query and returns all results as an array.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a>|<a href="yii-db-activerecord.html">yii\db\ActiveRecord</a>[]</span> <strong><a href="yii-db-activequery.html#all()-detail">all</a></strong> ( <span style="color: #0000BB">$db&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$db</span></td>
                  <td class="param-type-col"><a href="yii-db-connection.html">yii\db\Connection</a></td>
                  <td class="param-desc-col"><p>The DB connection used to create the DB command.
If null, the DB connection returned by <a href="yii-db-activequerytrait.html#$modelClass-detail">$modelClass</a> will be used.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a>|<a href="yii-db-activerecord.html">yii\db\ActiveRecord</a>[]</td>
                  <td class="param-desc-col"><p>The query results. If the query results in nothing, an empty array will be returned.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="andOnCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#andOnCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L698" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L698" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        andOnCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Adds an additional ON condition to the existing one.</strong></p>

        <p>The new condition and the existing one will be joined using the 'AND' operator.</p>

        <p>See also:</p><ul><li><a href="yii-db-activequery.html#onCondition()-detail">onCondition()</a></li><li><a href="yii-db-activequery.html#orOnCondition()-detail">orOnCondition()</a></li></ul>    </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#andOnCondition()-detail">andOnCondition</a></strong> ( <span style="color: #0000BB">$condition</span>, <span style="color: #0000BB">$params&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The new ON condition. Please refer to <a href="yii-db-querytrait.html#where()-detail">where()</a>
on how to specify this parameter.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The parameters (name =&gt; value) to be bound to the query.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>The query object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="createCommand()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#createCommand()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L310" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L310" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        createCommand()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a DB command that can be used to execute this query.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-command.html">yii\db\Command</a></span> <strong><a href="yii-db-activequery.html#createCommand()-detail">createCommand</a></strong> ( <span style="color: #0000BB">$db&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$db</span></td>
                  <td class="param-type-col"><a href="yii-db-connection.html">yii\db\Connection</a></td>
                  <td class="param-desc-col"><p>The DB connection used to create the DB command.
If null, the DB connection returned by <a href="yii-db-activequerytrait.html#$modelClass-detail">$modelClass</a> will be used.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-command.html">yii\db\Command</a></td>
                  <td class="param-desc-col"><p>The created DB command instance.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="init()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#init()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L119" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L119" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        init()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Initializes the object.</strong></p>

        <p>This method is called at the end of the constructor. The default implementation will trigger
an <a href="yii-db-activequery.html#EVENT_INIT-detail">EVENT_INIT</a> event. If you override this method, make sure you call the parent implementation at the end
to ensure triggering of the event.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-db-activequery.html#init()-detail">init</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="innerJoinWith()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#innerJoinWith()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L483" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L483" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        innerJoinWith()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Inner joins with the specified relations.</strong></p>

        <p>This is a shortcut method to <a href="yii-db-activequery.html#joinWith()-detail">joinWith()</a> with the join type set as "INNER JOIN".
Please refer to <a href="yii-db-activequery.html#joinWith()-detail">joinWith()</a> for detailed usage of this method.</p>

        <p>See also <a href="yii-db-activequery.html#joinWith()-detail">joinWith()</a>.</p>    </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#innerJoinWith()-detail">innerJoinWith</a></strong> ( <span style="color: #0000BB">$with</span>, <span style="color: #0000BB">$eagerLoading&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">true</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$with</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The relations to be joined with.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$eagerLoading</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Whether to eager loading the relations.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>The query object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="joinWith()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#joinWith()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L400" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L400" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        joinWith()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Joins with the specified relations.</strong></p>

        <p>This method allows you to reuse existing relation definitions to perform JOIN queries.
Based on the definition of the specified relation(s), the method will append one or multiple
JOIN statements to the current query.</p>
<p>If the <code>$eagerLoading</code> parameter is true, the method will also perform eager loading for the specified relations,
which is equivalent to calling <a href="yii-db-activequerytrait.html#with()-detail">with()</a> using the specified relations.</p>
<p>Note that because a JOIN query will be performed, you are responsible to disambiguate column names.</p>
<p>This method differs from <a href="yii-db-activequerytrait.html#with()-detail">with()</a> in that it will build up and execute a JOIN SQL statement
for the primary table. And when <code>$eagerLoading</code> is true, it will call <a href="yii-db-activequerytrait.html#with()-detail">with()</a> in addition with the specified relations.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#joinWith()-detail">joinWith</a></strong> ( <span style="color: #0000BB">$with</span>, <span style="color: #0000BB">$eagerLoading&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">true</span>, <span style="color: #0000BB">$joinType&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'LEFT&nbsp;JOIN'</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$with</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The relations to be joined. This can either be a string, representing a relation name or
an array with the following semantics:</p>
<ul>
<li>Each array element represents a single relation.</li>
<li>You may specify the relation name as the array key and provide an anonymous functions that
can be used to modify the relation queries on-the-fly as the array value.</li>
<li>If a relation query does not need modification, you may use the relation name as the array value.</li>
</ul>
<p>The relation name may optionally contain an alias for the relation table (e.g. <code>books b</code>).</p>
<p>Sub-relations can also be specified, see <a href="yii-db-activequerytrait.html#with()-detail">with()</a> for the syntax.</p>
<p>In the following you find some examples:</p>
<pre><code class="hljs php language-php"><span class="hljs-comment">// find all orders that contain books, and eager loading "books"</span>
Order::find()-&gt;joinWith(<span class="hljs-string">'books'</span>, <span class="hljs-keyword">true</span>, <span class="hljs-string">'INNER JOIN'</span>)-&gt;all();
<span class="hljs-comment">// find all orders, eager loading "books", and sort the orders and books by the book names.</span>
Order::find()-&gt;joinWith([
    <span class="hljs-string">'books'</span> =&gt; <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(\yii\db\ActiveQuery <span class="hljs-variable">$query</span>)</span> </span>{
        <span class="hljs-variable">$query</span>-&gt;orderBy(<span class="hljs-string">'item.name'</span>);
    }
])-&gt;all();
<span class="hljs-comment">// find all orders that contain books of the category 'Science fiction', using the alias "b" for the books table</span>
Order::find()-&gt;joinWith([<span class="hljs-string">'books b'</span>], <span class="hljs-keyword">true</span>, <span class="hljs-string">'INNER JOIN'</span>)-&gt;where([<span class="hljs-string">'b.category'</span> =&gt; <span class="hljs-string">'Science fiction'</span>])-&gt;all();
</code></pre>
<p>The alias syntax is available since version 2.0.7.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$eagerLoading</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Whether to eager load the relations specified in <code>$with</code>.
When this is a boolean, it applies to all relations specified in <code>$with</code>. Use an array
to explicitly list which relations in <code>$with</code> need to be eagerly loaded. Defaults to <code>true</code>.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$joinType</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The join type of the relations specified in <code>$with</code>.
When this is a string, it applies to all relations specified in <code>$with</code>. Use an array
in the format of <code>relationName =&gt; joinType</code> to specify different join types for different relations.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>The query object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="onCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#onCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L681" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L681" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        onCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Sets the ON condition for a relational query.</strong></p>

        <p>The condition will be used in the ON part when <a href="yii-db-activequery.html#joinWith()-detail">yii\db\ActiveQuery::joinWith()</a> is called.
Otherwise, the condition will be used in the WHERE part of a query.</p>
<p>Use this method to specify additional conditions when declaring a relation in the <a href="yii-db-activerecord.html">yii\db\ActiveRecord</a> class:</p>
<pre><code class="hljs php language-php"><span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">getActiveUsers</span><span class="hljs-params">()</span>
</span>{
    <span class="hljs-keyword">return</span> <span class="hljs-variable">$this</span>-&gt;hasMany(User::className(), [<span class="hljs-string">'id'</span> =&gt; <span class="hljs-string">'user_id'</span>])
                -&gt;onCondition([<span class="hljs-string">'active'</span> =&gt; <span class="hljs-keyword">true</span>]);
}
</code></pre>
<p>Note that this condition is applied in case of a join as well as when fetching the related records.
Thus only fields of the related table can be used in the condition. Trying to access fields of the primary
record will cause an error in a non-join-query.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#onCondition()-detail">onCondition</a></strong> ( <span style="color: #0000BB">$condition</span>, <span style="color: #0000BB">$params&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The ON condition. Please refer to <a href="yii-db-query.html#where()-detail">yii\db\Query::where()</a> on how to specify this parameter.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The parameters (name =&gt; value) to be bound to the query.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>The query object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="one()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#one()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L293" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L293" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        one()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Executes query and returns a single row of result.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activerecord.html">yii\db\ActiveRecord</a>|<a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.null">null</a></span> <strong><a href="yii-db-activequery.html#one()-detail">one</a></strong> ( <span style="color: #0000BB">$db&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$db</span></td>
                  <td class="param-type-col"><a href="yii-db-connection.html">yii\db\Connection</a></td>
                  <td class="param-desc-col"><p>The DB connection used to create the DB command.
If null, the DB connection returned by <a href="yii-db-activequerytrait.html#$modelClass-detail">$modelClass</a> will be used.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activerecord.html">yii\db\ActiveRecord</a>|<a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.null">null</a></td>
                  <td class="param-desc-col"><p>A single row of query result. Depending on the setting of <a href="yii-db-activequerytrait.html#asArray()-detail">asArray()</a>,
the query result may be either an array or an ActiveRecord object. Null will be returned
if the query results in nothing.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="orOnCondition()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#orOnCondition()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L719" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L719" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        orOnCondition()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Adds an additional ON condition to the existing one.</strong></p>

        <p>The new condition and the existing one will be joined using the 'OR' operator.</p>

        <p>See also:</p><ul><li><a href="yii-db-activequery.html#onCondition()-detail">onCondition()</a></li><li><a href="yii-db-activequery.html#andOnCondition()-detail">andOnCondition()</a></li></ul>    </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#orOnCondition()-detail">orOnCondition</a></strong> ( <span style="color: #0000BB">$condition</span>, <span style="color: #0000BB">$params&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The new ON condition. Please refer to <a href="yii-db-querytrait.html#where()-detail">where()</a>
on how to specify this parameter.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The parameters (name =&gt; value) to be bound to the query.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>The query object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="populate()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#populate()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L204" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L204" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        populate()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Converts the raw query results into the format as specified by this query.</strong></p>

        <p>This method is internally used to convert the data fetched from database
into the format as required by this query.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-db-activequery.html#populate()-detail">populate</a></strong> ( <span style="color: #0000BB">$rows</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$rows</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The raw query result from database</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The converted query result</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="prepare()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#prepare()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L139" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L139" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        prepare()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Prepares for building SQL.</strong></p>

        <p>This method is called by <a href="yii-db-querybuilder.html">yii\db\QueryBuilder</a> when it starts to build SQL from a query object.
You may override this method to do some final preparation work when converting a query into a SQL statement.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#prepare()-detail">prepare</a></strong> ( <span style="color: #0000BB">$builder</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$builder</span></td>
                  <td class="param-type-col"><a href="yii-db-querybuilder.html">yii\db\QueryBuilder</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>A prepared query instance which will be used by <a href="yii-db-querybuilder.html">yii\db\QueryBuilder</a> to build the SQL</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="queryScalar()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#queryScalar()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L331" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L331" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        queryScalar()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Queries a scalar value by setting <a href="yii-db-query.html#select()-detail">select()</a> first.</strong></p>

        <p>Restores the value of select to make this query reusable.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a>|<a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-db-activequery.html#queryScalar()-detail">queryScalar</a></strong> ( <span style="color: #0000BB">$selectExpression</span>, <span style="color: #0000BB">$db</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$selectExpression</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="yii-db-expression.html">yii\db\Expression</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$db</span></td>
                  <td class="param-type-col"><a href="yii-db-connection.html">yii\db\Connection</a>|<a href="http://www.php.net/language.types.null">null</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="viaTable()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#viaTable()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L752" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L752" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        viaTable()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Specifies the junction table for a relational query.</strong></p>

        <p>Use this method to specify a junction table when declaring a relation in the <a href="yii-db-activerecord.html">yii\db\ActiveRecord</a> class:</p>
<pre><code class="hljs php language-php"><span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">getItems</span><span class="hljs-params">()</span>
</span>{
    <span class="hljs-keyword">return</span> <span class="hljs-variable">$this</span>-&gt;hasMany(Item::className(), [<span class="hljs-string">'id'</span> =&gt; <span class="hljs-string">'item_id'</span>])
                -&gt;viaTable(<span class="hljs-string">'order_item'</span>, [<span class="hljs-string">'order_id'</span> =&gt; <span class="hljs-string">'id'</span>]);
}
</code></pre>

        <p>See also <a href="yii-db-activerelationtrait.html#via()-detail">via()</a>.</p>    </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-db-activequery.html">$this</a></span> <strong><a href="yii-db-activequery.html#viaTable()-detail">viaTable</a></strong> ( <span style="color: #0000BB">$tableName</span>, <span style="color: #0000BB">$link</span>, <span class="signature-type"><a href="http://www.php.net/language.types.callable">callable</a></span> <span style="color: #0000BB">$callable&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$tableName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the junction table.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$link</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The link between the junction table and the table associated with <a href="yii-db-activerelationtrait.html#$primaryModel-detail">$primaryModel</a>.
The keys of the array represent the columns in the junction table, and the values represent the columns
in the <a href="yii-db-activerelationtrait.html#$primaryModel-detail">$primaryModel</a> table.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$callable</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.callable">callable</a></td>
                  <td class="param-desc-col"><p>A PHP callback for customizing the relation associated with the junction table.
Its signature should be <code>function($query)</code>, where <code>$query</code> is the query to be customized.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-db-activequery.html">$this</a></td>
                  <td class="param-desc-col"><p>The query object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->
</div>
    <h2>Event Details</h2>

<div class="event-doc">
    <div class="detail-header h3" id="EVENT_INIT-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-db-activequery.html#EVENT_INIT-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2/edit/master/framework/db/ActiveQuery.php#L81" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php#L81" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        EVENT_INIT        <span class="detail-header-tag small">
        event
        of type \yii\db\Event                </span>
    </div>

    <div class="doc-description">
        <p>An event that is triggered when the query is initialized via <a href="yii-db-activequery.html#init()-detail">init()</a>.</p>

            </div>

</div>
    </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:49 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
